/* (c)2010-2013 Andrea Caltroni (andrea.caltroni@pd.infn.it), INFN (www.infn.it)
 *
 * This file is part of the IGI Survey Portlet (from here on shortened to IGISP).
 * IGISP is free software: you can redistribute it and/or modify it 
 * under the terms of the GNU General Public License as published by the Free 
 * Software Foundation, either version 3 of the License, or (at your option) any 
 * later version.
 *
 * IGISP is distributed in the hope that it will be useful, but WITHOUT ANY 
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
 * A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with IGISP. If not, see <http://www.gnu.org/licenses/>.
 */
package it.infn.grid.liferay.survey.modules.admin.controller;

import it.infn.grid.liferay.survey.modules.admin.web.AnswersTypePropertyEditor;
import it.infn.grid.liferay.survey.modules.admin.web.QuestionValidator;
import it.infn.grid.liferay.survey.modules.admin.web.SurveyPropertyEditor;

import java.util.Arrays;

import javax.portlet.ActionRequest;
import javax.portlet.ActionResponse;

import org.ajm.spring.survey.modules.admin.model.AnswersType;
import org.ajm.spring.survey.modules.admin.model.Question;
import org.ajm.spring.survey.modules.admin.model.Survey;
import org.ajm.spring.survey.modules.admin.service.QuestionService;
import org.ajm.spring.survey.modules.admin.service.SurveyService;
import org.apache.log4j.Logger;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.validation.BindingResult;
import org.springframework.validation.ObjectError;
import org.springframework.web.bind.annotation.InitBinder;
import org.springframework.web.bind.annotation.ModelAttribute;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.support.SessionStatus;
import org.springframework.web.portlet.bind.PortletRequestDataBinder;
import org.springframework.web.portlet.bind.annotation.ActionMapping;
import org.springframework.web.portlet.bind.annotation.RenderMapping;

/**
 * The controller for the edit question operation on the Question object.
 * 
 * @author Andrea Caltroni, andrea.caltroni@pd.infn.it, INFN
 */
@RequestMapping(value="VIEW")
@Controller(value="editQuestionController")
public class EditQuestionController {

    // ------------------------------------------------------------------------|
    // --- CONSTANTS ----------------------------------------------------------|
    // ------------------------------------------------------------------------|

    // --- CLASS VARIABLES ----------------------------------------------------|
    // ------------------------------------------------------------------------|
    // ------------------------------------------------------------------------|

    static Logger logger = Logger.getLogger(EditQuestionController.class);
    
    // ------------------------------------------------------------------------|
    // --- INSTANCE VARIABLES -------------------------------------------------|
    // ------------------------------------------------------------------------|

    @Autowired
    @Qualifier("surveyService")
    private SurveyService surveyService;
    
    @Autowired
    @Qualifier("questionService")
    private QuestionService questionService;
    
    @Autowired
    @Qualifier("questionValidator")
    private QuestionValidator questionValidator;
    
    // ------------------------------------------------------------------------|
    // --- CONSTRUCTORS -------------------------------------------------------|
    // ------------------------------------------------------------------------|

    // ------------------------------------------------------------------------|
    // --- CLASS METHODS ------------------------------------------------------|
    // ------------------------------------------------------------------------|

    // ------------------------------------------------------------------------|
    // --- INSTANCE METHODS ---------------------------------------------------|
    // ------------------------------------------------------------------------|

    /**
     * Setup binder for adding/editing surveys.
     */
    @InitBinder
    protected void initBinder(PortletRequestDataBinder binder) {
        
        binder.registerCustomEditor(Survey.class, new SurveyPropertyEditor(surveyService));
        binder.registerCustomEditor(AnswersType.class, new AnswersTypePropertyEditor());
    }

    // ------------------------------------------------------------------------|

    @ModelAttribute("question")
    public Question getCommandObject(@RequestParam("questionID") Long questionId) {
        
        return getQuestionService().findById(questionId);
    }

    // ------------------------------------------------------------------------|

    /**
     * Edits a question. Render phase.
     * 
     * @param surveyId 
     * @param questionId 
     * @param model 
     * @return The attribute in the model defining the action of editing a question.
     */
    @RenderMapping(params="action=showEditQuestionForm")
    public String showEditQuestionForm(@RequestParam("surveyID") Long surveyId, @RequestParam("questionID") Long questionId, Model model) {
        
        Question question = getQuestionService().findById(questionId);
        Survey survey = getSurveyService().findById(surveyId);
        model.addAttribute("survey", survey);
        model.addAttribute("answerTypeValues", Arrays.asList(AnswersType.values()));
        model.addAttribute("questionPositions", getSurveyService().findValidQuestionPositions(survey, question));
            
        return "questionEdit";
    }

    // ------------------------------------------------------------------------|

    /**
     * Saves a new or an edited question after validating it. Action phase.
     * 
     * @param request 
     * @param response 
     * @param question 
     * @param result 
     * @param sessionStatus 
     */
    @ActionMapping(params="action=editQuestion")
    public void submitEditQuestionForm(ActionRequest request, ActionResponse response,
            @ModelAttribute("question") Question question, BindingResult result, SessionStatus sessionStatus) {

        questionValidator.validate(question, result);
        
        if (!result.hasErrors()) {
            Question savedQuestion = questionService.save(question);
            response.setRenderParameter("action", "viewSurveyQuestions");
            response.setRenderParameter("surveyID", savedQuestion.getSurvey().getId().toString());
        }
        else {
            if (logger.isDebugEnabled()) {
                for (ObjectError error: result.getAllErrors()) {
                    logger.debug("Question edit form reported [" + error.toString() + "]");
                }
            }
            response.setRenderParameter("action", "showEditQuestionForm");
            response.setRenderParameter("surveyID", question.getSurvey().getId().toString());
            response.setRenderParameter("questionID", question.getId().toString());
        }
    }

    // --- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - --|
    // ---[  GETTERS AND SETTERS  ]--------------------------------------------|
    // --- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - --|

    /**
     * @return the questionValidator
     */
    public QuestionValidator getQuestionValidator() {
        
        return questionValidator;
    }

    // ------------------------------------------------------------------------|

    /**
     * @param questionValidator the questionValidator to set
     */
    public void setQuestionValidator(QuestionValidator questionValidator) {
        
        this.questionValidator = questionValidator;
    }

    // ------------------------------------------------------------------------|

    /**
     * @return the surveyService
     */
    public SurveyService getSurveyService() {
        
        return surveyService;
    }

    // ------------------------------------------------------------------------|

    /**
     * @param surveyService the surveyService to set
     */
    public void setSurveyService(SurveyService surveyService) {
        
        this.surveyService = surveyService;
    }

    // ------------------------------------------------------------------------|

    /**
     * @return the questionService
     */
    public QuestionService getQuestionService() {
        
        return questionService;
    }

    // ------------------------------------------------------------------------|

    /**
     * @param questionService the questionService to set
     */
    public void setQuestionService(QuestionService questionService) {
        
        this.questionService = questionService;
    }

    // ------------------------------------------------------------------------|

}
